<Balloon Menu Text> "Displays guided help for the Sprocket Starter program."
# ******************startup window**********
#define startup window, this is the window that Apple Guide
# first displays when the user chooses the menu item SurfWriter Guide
# If you specify a full access window, you can display HOWDY info OR (note the OR)
# OR you can specify which of the three buttons is initially active
# this example specifies HOWDY
<Startup Window> FULL, HOWDY
#You can choose FULL, SINGLE, or PRESENTATION as the startup window
#Full access windows allows topics, index, and look for, and Howdy
#Single access windows allows only topics and howdy
#Presentation allows a single sequence only
# ******************application logo*******
#Define either SurfWriter app logo or app text.
#Apple Guide displays the app logo or app text
# in the upper-left corner of SurfWriter Guide's Full Access window.
<App Text> "Sprocket Guide"
#if you choose to use app logo instead,
# define the filename that contains a PICT of your app's logo
# for example, <App Logo> "MyAppLogoPict", "MyAppLogoB&WPict"
#(Note that the file "Standard Resources" contains templates with
# PICT resource IDs 1501 and 1502 that you can modify appropriately and
# then use as the application logo picture associated with your guide).
#If you modify the PICT resources with IDs 1501 and 1502 then import the
# "Standard Resources" file, you can omit the <App Logo> command.
#If you store your app logo in a separate file, then remove the PICT resources
# with resource IDs 1501 and 1502 from the "Standard Resources" file.
#if you did include your own picture files, it might look something like this
#<App Logo> "Sprocket Color Logo", "Sprocket B&W Logo"
# ******************howdy text**************
#define the text for the Howdy screen
<Define Text Block> "Howdy Text"
Welcome to Apple Guide help for Worksheet Magic.
To start, click Topics, Index, or Look For.
Topics shows general categories and Index lists key words.
Look For lets you search for help according to key words you type.
<End Text Block>
#now specify the defined howdy text
<Howdy> "Howdy Text"
#To specify that your guide file appear only in the Help menu of your application,
#use this command and specify your application's creator, for example :
<App Creator> '75SL'
# ******************events**************
#These events and definitions are also defined in the Standard Setup file
#<Define Event> "DoHuh", 's***', 'help', 'dhuh'
<Define Event> "GoStart", 's***', 'help', 'stac'
#<Define Event> "GoBack", 's***', 'help', 'gobk'
# ******************navigation buttons*****
#<Define Nav Button> "Huh?", 1101, 1111, 1121, DIMMABLE
<Define Nav Button> "GoStart", 1100, 1102, 1104, GoStart()
<Define Nav Button Set> "Std nav bar", "GoStart"
#, "Huh?"
<TOPIC AREA> "General Information"
<HEADER> "How do I"
<TOPIC> "Start a new Sprocket project?" , "Starting a new Sprocket project"
<TOPIC> "Write an Apple Guide help file?" , "Writing for Apple Guide"
<HEADER> "Definitions"
<TOPIC> "Sprocket" , "What is Sprocket?"
<DEFINE PANEL> "Writing for Apple Guide"
By using the sample files which created the Guide you are reading now, you can have a working Apple Guide help solution up and running in minutes.
Withing the Sprocket folder is a folder called Sprocket Guide Files. In this folder you will find the source for this file, as well as a built copy. To create a Guide file, you will need Guide Maker, a free Apple Guide creation utility available from Apple. To edit the source, any text editor such as CodeWarrior or BBEdit will do.
Open the source file, and familiar yourself with the easy-to-understand Guide Script. Try changing a few things, then open Guide Maker. Click the Build button, then select the source (the file you just edited), and the target (the Sprocket Starter Guide). Click Build. Voila! Now move the new Sprocker Starter Guide into the same folder as Sprocket Starter (68k or PPC). Launch one of them, and you will see that your new guide is available under the help menu, and can also be triggered by the help key. In addition, you can open this guide file from within Sprocket, and you can even preset a search string in the guide file you open.
<END PANEL>
<DEFINE PANEL> "Starting a new Sprocket project"
To start a new project using the Sprocket Framework, you have two choices:
1. Make a copy of the SprocketNothing folder, and rename all references to SprocketNothing to whatever you choose. You will then be starting “from scratch”.
2. Make a copy of the SprocketStarter folder, and rename all references to SprocketStarter to whatever you choose. You will then be starting with a base text-editing application which has been designed to provide good examples of many of the key features of Sprocket.
<END PANEL>
<DEFINE PANEL> "What is Sprocket?"
xyz
<END PANEL>
<DEFINE SEQUENCE> "Starting a new Sprocket project"